Move documentation to inline comments: GtkRecentChooserMenu
authorJavier Jardón <jjardon@gnome.org>
Fri, 21 May 2010 01:19:02 +0000 (03:19 +0200)
committerJavier Jardón <jjardon@gnome.org>
Fri, 21 May 2010 01:19:02 +0000 (03:19 +0200)
docs/reference/gtk/tmpl/.gitignore
docs/reference/gtk/tmpl/gtkrecentchoosermenu.sgml [deleted file]
gtk/gtkrecentchoosermenu.c

index f298ba457f56d65d7003e9b51f13ed8f83ff94b8..d60266462ee335b9cf82909aa981bf059cc36c5c 100644 (file)
@@ -12,6 +12,7 @@ gtkradiobutton.sgml
 gtkrange.sgml
 gtkrecentaction.sgml
 gtkrecentchooser.sgml
+gtkrecentchoosermenu.sgml
 gtkrecentchooserwidget.sgml
 gtkscalebutton.sgml
 gtkseparator.sgml
diff --git a/docs/reference/gtk/tmpl/gtkrecentchoosermenu.sgml b/docs/reference/gtk/tmpl/gtkrecentchoosermenu.sgml
deleted file mode 100644 (file)
index 0de670b..0000000
+++ /dev/null
@@ -1,92 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkRecentChooserMenu
-
-<!-- ##### SECTION Short_Description ##### -->
-Displays recently used files in a menu
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-#GtkRecentChooserMenu is a widget suitable for displaying recently used files
-inside a menu.  It can be used to set a sub-menu of a #GtkMenuItem using
-gtk_menu_item_set_submenu(), or as the menu of a #GtkMenuToolButton.
-</para>
-
-<para>
-Note that #GtkRecentChooserMenu does not have any methods of its own.  Instead,
-you should use the functions that work on a #GtkRecentChooser.
-</para>
-
-<para>
-Note also that #GtkRecentChooserMenu does not support multiple filters, as it
-has no way to let the user choose between them as the #GtkRecentChooserWidget
-and #GtkRecentChooserDialog widgets do. Thus using gtk_recent_chooser_add_filter()
-on a #GtkRecentChooserMenu widget will yield the same effects as using
-gtk_recent_chooser_set_filter(), replacing any currently set filter
-with the supplied filter; gtk_recent_chooser_remove_filter() will remove
-any currently set #GtkRecentFilter object and will unset the current filter;
-gtk_recent_chooser_list_filters() will return a list containing a single
-#GtkRecentFilter object.
-</para>
-
-<para>
-Recently used files are supported since GTK+ 2.10.
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-#GtkRecentChooser
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkRecentChooserMenu ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GtkRecentChooserMenu:show-numbers ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_recent_chooser_menu_new ##### -->
-<para>
-
-</para>
-
-@void: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_recent_chooser_menu_new_for_manager ##### -->
-<para>
-
-</para>
-
-@manager: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_recent_chooser_menu_get_show_numbers ##### -->
-<para>
-
-</para>
-
-@menu: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_recent_chooser_menu_set_show_numbers ##### -->
-<para>
-
-</para>
-
-@menu: 
-@show_numbers: 
-
-
index 1dd2ac26a39ab9ffcf000863802b98560c299634..f77643b6586501d44ad997cb81540e14b7aa00fa 100644 (file)
 #include "gtkprivate.h"
 #include "gtkalias.h"
 
+
+/**
+ * SECTION:gtkrecentchoosermenu
+ * @Short_description: Displays recently used files in a menu
+ * @Title: GtkRecentChooserMenu
+ * @See_also:#GtkRecentChooser
+ *
+ * #GtkRecentChooserMenu is a widget suitable for displaying recently used files
+ * inside a menu.  It can be used to set a sub-menu of a #GtkMenuItem using
+ * gtk_menu_item_set_submenu(), or as the menu of a #GtkMenuToolButton.
+ *
+ * Note that #GtkRecentChooserMenu does not have any methods of its own. Instead,
+ * you should use the functions that work on a #GtkRecentChooser.
+ *
+ * Note also that #GtkRecentChooserMenu does not support multiple filters, as it
+ * has no way to let the user choose between them as the #GtkRecentChooserWidget
+ * and #GtkRecentChooserDialog widgets do. Thus using gtk_recent_chooser_add_filter()
+ * on a #GtkRecentChooserMenu widget will yield the same effects as using
+ * gtk_recent_chooser_set_filter(), replacing any currently set filter
+ * with the supplied filter; gtk_recent_chooser_remove_filter() will remove
+ * any currently set #GtkRecentFilter object and will unset the current filter;
+ * gtk_recent_chooser_list_filters() will return a list containing a single
+ * #GtkRecentFilter object.
+ *
+ * Recently used files are supported since GTK+ 2.10.
+ */
+
+
 struct _GtkRecentChooserMenuPrivate
 {
   /* the recent manager object */